/**
 * Software License, Version 1.0
 * 
 * Copyright 2003 The Trustees of Indiana University.  All rights reserved.
 * 
 *
 *Redistribution and use in source and binary forms, with or without 
 *modification, are permitted provided that the following conditions are met:
 *
 *1) All redistributions of source code must retain the above copyright notice,
 * the list of authors in the original source code, this list of conditions and
 * the disclaimer listed in this license;
 *2) All redistributions in binary form must reproduce the above copyright 
 * notice, this list of conditions and the disclaimer listed in this license in
 * the documentation and/or other materials provided with the distribution;
 *3) Any documentation included with all redistributions must include the 
 * following acknowledgement:
 *
 *"This product includes software developed by the Community Grids Lab. For 
 * further information contact the Community Grids Lab at 
 * http://communitygrids.iu.edu/."
 *
 * Alternatively, this acknowledgement may appear in the software itself, and 
 * wherever such third-party acknowledgments normally appear.
 * 
 *4) The name Indiana University or Community Grids Lab or NaradaBrokering, 
 * shall not be used to endorse or promote products derived from this software 
 * without prior written permission from Indiana University.  For written 
 * permission, please contact the Advanced Research and Technology Institute 
 * ("ARTI") at 351 West 10th Street, Indianapolis, Indiana 46202.
 *5) Products derived from this software may not be called NaradaBrokering, 
 * nor may Indiana University or Community Grids Lab or NaradaBrokering appear
 * in their name, without prior written permission of ARTI.
 * 
 *
 * Indiana University provides no reassurances that the source code provided 
 * does not infringe the patent or any other intellectual property rights of 
 * any other entity.  Indiana University disclaims any liability to any 
 * recipient for claims brought by any other entity based on infringement of 
 * intellectual property rights or otherwise.  
 *
 *LICENSEE UNDERSTANDS THAT SOFTWARE IS PROVIDED "AS IS" FOR WHICH NO 
 *WARRANTIES AS TO CAPABILITIES OR ACCURACY ARE MADE. INDIANA UNIVERSITY GIVES
 *NO WARRANTIES AND MAKES NO REPRESENTATION THAT SOFTWARE IS FREE OF 
 *INFRINGEMENT OF THIRD PARTY PATENT, COPYRIGHT, OR OTHER PROPRIETARY RIGHTS. 
 *INDIANA UNIVERSITY MAKES NO WARRANTIES THAT SOFTWARE IS FREE FROM "BUGS", 
 *"VIRUSES", "TROJAN HORSES", "TRAP DOORS", "WORMS", OR OTHER HARMFUL CODE.  
 *LICENSEE ASSUMES THE ENTIRE RISK AS TO THE PERFORMANCE OF SOFTWARE AND/OR 
 *ASSOCIATED MATERIALS, AND TO THE PERFORMANCE AND VALIDITY OF INFORMATION 
 *GENERATED USING SOFTWARE.
 */
package cgl.narada.service.qos;

import java.security.PublicKey;
import java.util.Properties;

import javax.crypto.SecretKey;

import cgl.narada.matching.Profile;
import cgl.narada.service.ServiceException;
import cgl.narada.service.security.kmc.SignedSecurityToken;

/**
 * Allows a consumer to specify QosConstraints on the sending or receiving of
 * events conforming to a given profile
 * 
 * @author Shrideep Pallickara $Date$ $Revision$
 */

public interface ConsumerConstraints {
    public int getEntityId();

    /**
     * Returns the templateId associated with the consumer constraint. There can
     * be only one consumer constraint associated with a given consumer. If the
     * templateId has NOT BEEN SET by one of the setter method, this method WILL
     * RETURN 0. Otherwise it will return the value of the templateId
     */
    public int getTemplateId();

    public Profile getProfile();

    /**
     * Enable ordered delivery of events corresponding to this template. This
     * method will throw an exception if the templateId specified during any of
     * the previous invocations of methods (with the templateId argument) is
     * different from the one specified in this method
     */
    public void setReceiveInOrder(int ordTemplateId) throws ServiceException;

    /**
     * Enable reliable delivery of events corresponding to this template. This
     * method will throw an exception if the templateId specified during any of
     * the previous invocations of methods (with the templateId argument) is
     * different from the one specified in this method
     */
    public void setReceiveReliably(int recTemplateId) throws ServiceException;

    /**
     * Enable secure delivery of events corresponding to this template. This
     * method will throw an exception if the templateId specified during any of
     * the previous invocations of methods (with the templateId argument) is
     * different from the one specified in this method
     */
    public void setReceiveSecurely(int secTemplateId) throws ServiceException;

    public void setReceiveAfterPayloadDecompression();

    public void setReceiveAfterCoalescingFragments();

    /**
     * Ensures that events are ordered in time before they are released. The
     * events are buffered for a duration of time prior to the release.
     */
    public void setReceiveInTimeOrder();

    /**
     * Ensures that events are spaced in time before they are released. This
     * feature is traditionally used during the replay of audio-video multimedia
     * streams
     */
    public void setReceiveAfterTimeSpacing();

    public boolean isReceiveInOrder();

    public boolean isReceiveReliably();

    public boolean isReceiveSecurely();

    public boolean isReceiveAfterCoalescingFragments();

    public boolean isReceiveAfterPayloadDecompression();

    public boolean hasSatisfiedSpecifiedConstraints(QosIdentifiers identifiers);

    public boolean isReceiveInTimeOrder();

    public boolean isReceiveAfterTimeSpacing();

    // HG:

    /**
     * Sets the security token, secret key and decryption properties associated
     * with the decryption for this profile
     * 
     * @param sst
     * @param key
     * @param props
     * @param doNotDecryptPayloadBeforeDelivery
     * @param rootCAPubKey
     */
    public void setSecurityToken(SignedSecurityToken sst, SecretKey key,
            Properties props, boolean doNotDecryptPayloadBeforeDelivery,
            PublicKey rootCAPubKey);

    public SignedSecurityToken getSignedSecurityToken();

    public SecretKey getSecretKey();

    public Properties getDecryptionProperties();

    public boolean isNoDecryptionRequested();

    public PublicKey getRootCAPublicKey();
    // -----
}
